/*
 * Copyright (c) 2007 jMouse Gestures
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 *
 * * Neither the name of 'jMouse Gestures' nor the names of its contributors 
 *   may be used to endorse or promote products derived from this software 
 *   without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package com.jmg.gesture.event;

import com.jmg.gesture.GestureManager;
import com.jmg.space.Location;


/**
 * GestureListener interface is used to listen for gestures starting and
 * stopping.
 *
 * @author  Christopher Martin
 * @version $Id: GestureListener.java 4 2007-04-12 16:55:33Z GentlemanHal $
 */
public interface GestureListener {
    /**
     * This method should be called when mouse and keyboard modifiers are
     * valid and a gesture has started being performed.
     * 
     * @param when The time this event happened.
     * @param where The position of the mouse when this event happened.
     * @param manager The manager that created this event.
     * @see   System#currentTimeMillis
     */
    public void gestureStarted(long when, Location where, GestureManager<?> manager);
    
    /**
     * This method should be called when a gesture is being performed and
     * the mouse moves.
     * 
     * @param when The time this event happened.
     * @param where The position of the mouse when this event happened.
     * @param manager The manager that created this event.
     * @see   System#currentTimeMillis
     */
    public void gestureMovement(long when, Location where, GestureManager<?> manager);
    
    /**
     * This method should be called when a gesture that was started is finished.
     * <p>
     * <strong>Note:</strong><br />
     * This method is <strong>not</strong> called when a <em>valid</em> gesture is
     * performed, just when <em>any</em> started gesture is finished for any reason
     * (cancelled, timed out etc).  To listen for valid gestures being performed
     * implement {@link com.jmg.gesture.event.GesturePerformedListener}.
     * </p>
     * 
     * @param when The time this event happened.
     * @param where The position of the mouse when this event happened.
     * @param manager The manager that created this event.
     * @see   System#currentTimeMillis
     */
    public void gestureFinished(long when, Location where, GestureManager<?> manager);
}
